home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 21
/
Cream of the Crop 21 (Terry Blount) (October 1996).iso
/
bbs
/
msrch10.zip
/
MULTSRCH.DOC
< prev
next >
Wrap
Text File
|
1996-07-01
|
21KB
|
417 lines
Documentation for MultiSearch Text Door
Written by Robert V. Chambers
Copyright (c) 1996
WHAT IS MULTISEARCH TEXT DOOR?
MultiSearch Text Door is a BBS door program that will let you, the sysop, make
text files available to your users for on-line viewing, searching, and
downloading. Sounds dull, right? Well, there's a catch. This door makes it
possible to not only view a file but to also search for text within the file.
And not just within one file, either. With MultiSearch Text Door you can elect
to search across any files that are available and display the results a page
at a time, or only display the lines that meet the search criteria. Just
select the files of interest, enter text to search for, and let it go. It's
the perfect utility door for scanning your log files, making game
documentation or faq sheets available, etc. MultiSearch Text Door makes it
extremely easy to access the information you and your users want and need.
With DSZ your user can download any file that he/she has clearance to view.
The door provides ANSI graphics file capability so that you can make your
favorite ANSIs available to your users, thus extending the functionality of
the door. Though the primary function is text reading and searching, this
feature was added at the encouragement of the beta testers.
While most doors are aimed at either the user or the sysop, this one will
benefit both.
SYSTEM REQUIREMENTS:
386 or better processor
220K memory (probably less, just being conservative).
WHAT ARE SOME OF THE FEATURES?
* Search multiple files for information.
* Display ANSI graphics files.
* Up to 225 files can be made available. (Registered only)
* Download files of interest. (Requires DSZ)
* Up to 20 document categories.
* Optional activity log.
* On-line help.
* Simple Boolean search patterns.
* Page numbering.
* Displays file size and date.
* File-specific security clearance.
* Custom color configuration of file and category menus.
* Comes complete with menu editor for adding or removing documents.
* Has a sysop chat mode.
* Fossil aware.
* Supports standard drop files such as DOOR.SYS (PCBoard/GAP),
DORINFO1.DEF, EXITINFO.BBS, CHAIN.TXT, etc.
* Supports multiple nodes.
* Includes an editor to make menu maintenance a snap.
* These are the basics, but there's lots more!
LIMITATIONS ON UNREGISTERED VERSION:
The unregistered version will only support 10 documents in the menu. You must
register the program to eliminate this restriction. See the section on
registration below.
WHERE ARE THE INSTRUCTIONS ON USAGE?
All instructions on how to use the door once it has been installed are in the
on-line help file. If you can't wait, and want to read it now, the help file
is called "multsrch.hlp". Be careful that you don't inadvertently change the
wording in the file, since this is the one that will be displayed when the
user enters on-line help! Of course, you are free to edit it if you wish, and
may even like to add some additional information.
HOW DO I INSTALL IT:
This is simple, but you must follow these instructions. I am assuming that you
are already familiar with the steps required to install a door on your BBS. If
not, I would suggest that you read your manual first. This doc will not
attempt to guide you through that.
Step 1) Unzip all files into a single directory of your choice.
Step 2) Create a batch file that your BBS will use to start the door. I use
PCBoard, and my file looks something like this:
@echo off
cd\pcb\search
multsrch.exe c:\pcb\node1\door.sys /L
IF "%INPCB"=="Y" EXIT
%PCBDRIVE%
%PCBDIR%
board
You may call the file whatever you like, subject to restrictions that
may be enforced by your BBS software. Mine is simply called SEARCH,
with no .BAT extension. Again, consult your manual.
A little explanation of the startup batch file is in order here. The
first line simply changes to the directory where all of your
MultiSearch Text Door program files are found. (Remember you put them
there in Step 1.) The second line is the name of the door program,
MULTSRCH.EXE, followed by the complete path to your drop file and the
(optional) log file switch. Notice that the drop file name is
specified. If you are using PCBoard, you may also use the PCBoard
environment variables for the path to the drop file. Like this:
multsrch.exe %PCBDRIVE%%PCBDIR%\door.sys
If you wish the program to log its activities, add "/L" after the path
to the drop file like this:
multsrch.exe %PCBDRIVE%%PCBDIR%\door.sys /L
The program will create MULTSRCH.LOG which will contain information on
door usage. See the section below on "LOGGING ACTIVITY".
Finally, use whatever door exiting statements your software
recommends. Your startup file will undoubtedly look different, but you
get the general idea.
Step 3)
Set up the category menu. If you want to set up categories for your
documents (and you should!) you must first create MAIN.CFG using any
ASCII text editor. Refer to SAMPLE1.CFG for complete instructions on
the contents of this file. This file is very simple and contains only
the number of categories you wish to use and the description of each.
If you do not want to use categories, but would rather have all of the
files listed in a single menu, you can skip this step. The program
will provide your users with an option to list all files, so there is
really no reason not to set up categories. Also, you will not have
access to the door statistics or file properties display since the
menu option for these functions is available only through the category
menu.
Note that the category configuration file MUST be called MAIN.CFG, and
MUST reside in the program file directory. The first category listed
will be category 1, the second category 2, and so forth. You may
define a maximum of 20 categories in either the registered or
unregistered version.
Step 4)
Next run MULTEDIT.EXE to build the document list menu. This program
will build the menu configuration file, MULTSRCH.CFG and add a default
entry. Edit this entry with the proper information for your first
document. MULTEDIT.EXE is a very simple program that will let you add,
modify, and delete document entries, change your registration
information, etc. You should use this program each time you wish to
make modifications to your document menu. See MULTEDIT.DOC information
on this program.
Alternatively you can use any text editor to edit MULTSRCH.CFG.
Complete instructions for editing are included in SAMPLE2.CFG. Be sure
to follow these carefully. Note that no lines can be skipped and
comments are not allowed. An explanation of each line in the file is
included in SAMPLE2.CFG. I don't recommend this because it's too easy
to make a mistake.
If you have ANSI graphics files you would like to make available, they
must contain ".ANS" in the filename (usually the file extension).
Non-graphics users will not be able to display these files.
NOTE: Using categories is optional. However, the program presents a
much more organized environment for the user with categorized
documents. Without the category menu the user will see all of the
files listed together in a single menu